Interface EMEAScriptEngine

All Superinterfaces:
IPCObject
All Known Subinterfaces:
ActivityScriptEngine
All Known Implementing Classes:
ActivityScriptEngineImpl, EMEAScriptEngineImpl

public interface EMEAScriptEngine extends IPCObject
Information provided by the PKI file:

    \class EMEAScriptEngine
    
    \brief EMEAScriptEngine gives access to Packet Tracer's Script Engine.
    
    \example appWindow().getActiveFile().getScriptEngine()
    
Author:
Auto-generated
  • Method Details

    • evaluateFile

      ScriptValue evaluateFile(String filepath)
      Information provided by the PKI file:
      
          \brief Evaluates the specified script.
          
          \param filepath, the filepath of the script of interest.
          
          \return ScriptValue, the ScriptValue object of the specified script.
          
              
      Parameters:
      filepath - Takes in a parameter of filepath
      Returns:
      ScriptValue Returns a ScriptValue
    • canEvaluate

      boolean canEvaluate(String program)
      Information provided by the PKI file:
      
          \brief Returns true if the specified script can be evaluated, otherwise false.
          
          \param program, the code of the script of interest.
          
          \return bool, true if the specified script can be evaluated, otherwise false.
          
              
      Parameters:
      program - Takes in a parameter of program
      Returns:
      boolean Returns a boolean
    • globalObject

      ScriptValue globalObject()
      Information provided by the PKI file:
      
          \brief Returns the global ScriptValue object.
          
          \return ScriptValue, the global ScriptValue object.
          
              
      Returns:
      ScriptValue Returns a ScriptValue
    • evaluate

      ScriptValue evaluate(String program, String id)
      Information provided by the PKI file:
      
          \brief Evaluates the specified script.
          
          \param program, the code of the script of interest.
          \param id, the name of the script of interest.
          
          \return ScriptValue, the ScriptValue object of the specified script.
          
              
      Parameters:
      program - Takes in a parameter of program
      id - Takes in a parameter of id
      Returns:
      ScriptValue Returns a ScriptValue
    • createScriptValueInt

      ScriptValue createScriptValueInt(int value)
      Information provided by the PKI file:
      
          \brief Creates a ScriptValue object with the specified integer value.
          
          \param value, the integer value of the ScriptValue object.
          
          \return ScriptValue, the ScriptValue object.
          
              
      Parameters:
      value - Takes in a parameter of value
      Returns:
      ScriptValue Returns a ScriptValue
    • createScriptValueBool

      ScriptValue createScriptValueBool(boolean value)
      Information provided by the PKI file:
      
          \brief Creates a ScriptValue object with the specified boolean value.
          
          \param value, the boolean value of the ScriptValue object.
          
          \return ScriptValue, the ScriptValue object.
          
              
      Parameters:
      value - Takes in a parameter of value
      Returns:
      ScriptValue Returns a ScriptValue
    • createScriptValueQString

      ScriptValue createScriptValueQString(String value)
      Information provided by the PKI file:
      
          \brief Creates a ScriptValue object with the specified QString value.
          
          \param value, the QString value of the ScriptValue object.
          
          \return ScriptValue, the ScriptValue object.
          
              
      Parameters:
      value - Takes in a parameter of value
      Returns:
      ScriptValue Returns a ScriptValue